home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgramD2.iso / Borland / Borland Pascal with Objects 7.0 / WHEREIS.ZIP / WHEREIS.DOC < prev    next >
Text File  |  1992-10-27  |  5KB  |  120 lines
  1.  
  2.                           WHEREIS 2.0
  3.                           -----------
  4.  
  5.  
  6. TABLE OF CONTENTS
  7. -----------------
  8.  
  9. 1. What is WHEREIS?
  10. 2. How to Use WHEREIS
  11. 3. How to Assemble WHEREIS
  12.  
  13.  
  14. 1. WHAT IS WHEREIS?
  15. -------------------
  16.  
  17.   WHEREIS is a utility that searches a disk for files that match a 
  18.   user-supplied file specification. The utility performs a recursive search 
  19.   through any subdirectories it finds during its search. WHEREIS can be given
  20.   multiple file specifications, and will show all files that match any of the 
  21.   given file specifications. WHEREIS can also be instructed to perform a
  22.   DOS command on each of the files that is found.
  23.  
  24. 2. HOW TO USE WHEREIS
  25. ---------------------
  26.  
  27.   To search an entire disk for a particular file specification, you would 
  28.   execute WHEREIS like this:
  29.  
  30.     whereis *.asm
  31.  
  32.   This would search through the entire drive (the current drive) and display 
  33.   each instance of a file matching the file specification *.asm.
  34.  
  35.   You can also provide an explicit drive specifier:
  36.  
  37.     whereis a:\*.asm
  38.  
  39.   This will search drive A: for all matching files.
  40.  
  41.   If you don't want to search an entire disk, you can explicitly define the 
  42.   path from which to start the recursive search. For example,
  43.  
  44.     whereis c:\borland\tasm\*.asm
  45.  
  46.   will search for all files matching *.asm in the directory c:\borland\tasm 
  47.   and any subdirectories below it.
  48.  
  49.   You can halt execution of WHEREIS by pressing any key while it's running.
  50.   You will be given a message that execution has been interrupted when the
  51.   next file is found. For immediate interruption, press Control-Break. If
  52.   you want to pause execution of WHEREIS, press the space bar. You will be
  53.   given a prompt to press the spacebar a second time to resume the search.
  54.  
  55.   If you want to search for several file specifications, just enter multiple 
  56.   file specifications on the command line. For example,
  57.  
  58.     whereis c:\borland\tasm\*.asm *.inc
  59.  
  60.   will search for all the files matching *.asm or *.inc in the directory
  61.   c:\borland\tasm and any subdirectories below it. Note that only the first 
  62.   file specification may contain a drive and path specification.
  63.  
  64.   If you want to perform a dos command on each file that WHEREIS finds,
  65.   you can give the dos command in delimiters on the command line. Valid
  66.   delimiters are '', "", or []. The dos command should contain one of the
  67.   following variables, that will substitute a given string on the command 
  68.   line used for the dos command:
  69.  
  70.      %1 - Insert full path, filename and extension
  71.      %2 - Filename and extension (no path)
  72.      %3 - Only the path.
  73.      %4 - Only the filename before the extension followed by a .
  74.      %5 - Only the extension, preceded by a .
  75.  
  76.   For example,
  77.  
  78.      whereis *.bak [del %2]
  79.  
  80.   will delete all .BAK files from your drive.
  81.  
  82.   Another example is,
  83.  
  84.      whereis *.asm *.inc [grep -i ideal %2]
  85.  
  86.   which will search all *.ASM and all *.INC files for the word ideal.
  87.  
  88.   When the dos command is given, it will be given in the same directory that
  89.   the file was found in. Note that the DOS command could also be a call to a 
  90.   batch file. Whatever command, executable, or batch file, that is specified 
  91.   should be reachable with the current PATH environment variable, or a 
  92.   specific path to the executable or batch file should be given within the 
  93.   delimiters. Also the command should return to the same directory that it
  94.   was called from.
  95.  
  96.   Since WHEREIS calls COMMAND.COM to do the work of executing the given DOS 
  97.   command for each file that is found, performance is best if COMMAND.COM 
  98.   is placed on a RAM disk and the COMSPEC= environment variable is updated to 
  99.   point to the new copy of COMMAND.COM. For a complete discussion of RAM 
  100.   disks and how to set the COMSPEC= environment variable, please see your
  101.   DOS manual.
  102.  
  103.  
  104. 3. HOW TO ASSEMBLE WHEREIS
  105. --------------------------
  106.  
  107.   In order to assemble WHEREIS, execute the following command on the DOS 
  108.   command line:
  109.  
  110.     make -fwhereis
  111.  
  112.   This will execute the command-line make utility MAKE.EXE and pass it the 
  113.   make file WHEREIS.MAK. For instructions on assembling specific modules in 
  114.   the WHEREIS program, see the comments at the top of each module.
  115.  
  116.   WHEREIS has been rewritten since Turbo Assembler 1.01 to show off some of 
  117.   the new features of Turbo Assembler 2.0. The file IWHEREIS.ASM has many of 
  118.   the features specially noted. Refer to that file for more details.
  119.  
  120.